<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>MavenOverviewMojo xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/com/googlecode/maven/plugins/overview/MavenOverviewMojo.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong class="jxr_keyword">package</strong> com.googlecode.maven.plugins.overview;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <strong class="jxr_keyword">import</strong> com.googlecode.maven.plugins.overview.logic.DependencyProcessor;
<a name="4" href="#4">4</a>   <strong class="jxr_keyword">import</strong> com.googlecode.maven.plugins.overview.render.MyEdgeStringer;
<a name="5" href="#5">5</a>   <strong class="jxr_keyword">import</strong> com.googlecode.maven.plugins.overview.render.MyVertexPaintFunction;
<a name="6" href="#6">6</a>   <strong class="jxr_keyword">import</strong> com.googlecode.maven.plugins.overview.render.MyVertexShapeFunction;
<a name="7" href="#7">7</a>   <strong class="jxr_keyword">import</strong> com.googlecode.maven.plugins.overview.render.MyVertexStringer;
<a name="8" href="#8">8</a>   <strong class="jxr_keyword">import</strong> edu.uci.ics.jung.graph.DirectedGraph;
<a name="9" href="#9">9</a>   <strong class="jxr_keyword">import</strong> edu.uci.ics.jung.visualization.*;
<a name="10" href="#10">10</a>  <strong class="jxr_keyword">import</strong> edu.uci.ics.jung.visualization.contrib.KKLayout;
<a name="11" href="#11">11</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.factory.ArtifactFactory;
<a name="12" href="#12">12</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.metadata.ArtifactMetadataSource;
<a name="13" href="#13">13</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.repository.ArtifactRepository;
<a name="14" href="#14">14</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.resolver.ArtifactCollector;
<a name="15" href="#15">15</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.Sink;
<a name="16" href="#16">16</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.Renderer;
<a name="17" href="#17">17</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
<a name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.AbstractMavenReport;
<a name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReportException;
<a name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.shared.dependency.tree.DependencyTreeBuilder;
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> javax.imageio.ImageIO;
<a name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> java.awt.*;
<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> java.awt.image.BufferedImage;
<a name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> java.io.File;
<a name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> java.io.IOException;
<a name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> java.util.Arrays;
<a name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> java.util.List;
<a name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> java.util.Locale;
<a name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> java.util.ResourceBundle;
<a name="31" href="#31">31</a>  
<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment">/**</em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> * Maven Overview Plugin.</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment"> * Generates overview graph of project dependencies.</em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment"> *</em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment"> * @author Wilfred Springer</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment"> * @author Hubert Iwaniuk</em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> * @goal overview</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> * @phase site</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> */</em>
<a name="42" href="#42">42</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../com/googlecode/maven/plugins/overview/MavenOverviewMojo.html">MavenOverviewMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMavenReport {
<a name="43" href="#43">43</a>  
<a name="44" href="#44">44</a>    <em class="jxr_javadoccomment">/**</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment">   * Exclusions configuration.</em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment">   * &lt;p/&gt;</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment">   * &lt;pre&gt;</em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment">   * &amp;lt;exclusions&amp;gt;</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment">   *  &amp;lt;exclusion&amp;gt; &amp;lt;!-- all info provided, all have to match to exclude --&amp;gt;</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment">   *   &amp;lt;groupId&amp;gt;groupRegExp&amp;lt;/groupId&amp;gt;</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment">   *   &amp;lt;artifactId&amp;gt;artivaftRegExp&amp;lt;/artifactId&amp;gt;</em>
<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment">   *   &amp;lt;packaging&amp;gt;packaginRegExp&amp;lt;/packaging&amp;gt;</em>
<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment">   *   &amp;lt;version&amp;gt;versionRegExp&amp;lt;/version&amp;gt;</em>
<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment">   *   &amp;lt;scope&amp;gt;scopeRegExp&amp;lt;/scope&amp;gt;</em>
<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment">   *  &amp;lt;/exclusion&amp;gt;</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment">   *  &amp;lt;exclusion&amp;gt; &amp;lt;!-- only one provided --&amp;gt;</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">   *   &amp;lt;scope&amp;gt;scopeRegExp&amp;lt;/scope&amp;gt;</em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment">   *  &amp;lt;/exclusion&amp;gt;</em>
<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment">   * &amp;lt;/exclusions&amp;gt;</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment">   * &lt;/pre&gt;</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment">   *</em>
<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment">   * @parameter</em>
<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment">   */</em>
<a name="64" href="#64">64</a>    List&lt;Exclusion&gt; exclusions;
<a name="65" href="#65">65</a>  
<a name="66" href="#66">66</a>    <em class="jxr_javadoccomment">/**</em>
<a name="67" href="#67">67</a>  <em class="jxr_javadoccomment">   * GroupIDs of artifacts to be included.</em>
<a name="68" href="#68">68</a>  <em class="jxr_javadoccomment">   * &lt;p/&gt;</em>
<a name="69" href="#69">69</a>  <em class="jxr_javadoccomment">   * Coma separated list of included artifacts GroupIDs.</em>
<a name="70" href="#70">70</a>  <em class="jxr_javadoccomment">   *</em>
<a name="71" href="#71">71</a>  <em class="jxr_javadoccomment">   * @parameter expression="${includes}"</em>
<a name="72" href="#72">72</a>  <em class="jxr_javadoccomment">   */</em>
<a name="73" href="#73">73</a>    String includes = <span class="jxr_string">""</span>;
<a name="74" href="#74">74</a>    
<a name="75" href="#75">75</a>    <em class="jxr_javadoccomment">/**</em>
<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">   * Maximum depth to pursue transitive dependencies</em>
<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">   * &lt;p/&gt;</em>
<a name="78" href="#78">78</a>  <em class="jxr_javadoccomment">   * </em>
<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">   * @parameter expression="${maxDepth}"</em>
<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">   */</em>
<a name="81" href="#81">81</a>    <strong class="jxr_keyword">int</strong> maxDepth = -1;
<a name="82" href="#82">82</a>    
<a name="83" href="#83">83</a>    <em class="jxr_javadoccomment">/**</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">   * If specified, only the specified scopes are pursued when traversing the dependency tree</em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">   * &lt;p/&gt;</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">   * </em>
<a name="87" href="#87">87</a>  <em class="jxr_javadoccomment">   * @parameter expression="${scopes}"</em>
<a name="88" href="#88">88</a>  <em class="jxr_javadoccomment">   */</em>
<a name="89" href="#89">89</a>    String[] scopes = <strong class="jxr_keyword">null</strong>;
<a name="90" href="#90">90</a>  
<a name="91" href="#91">91</a>    <em class="jxr_javadoccomment">/**</em>
<a name="92" href="#92">92</a>  <em class="jxr_javadoccomment">   * Rendered graph width in pixels.</em>
<a name="93" href="#93">93</a>  <em class="jxr_javadoccomment">   *</em>
<a name="94" href="#94">94</a>  <em class="jxr_javadoccomment">   * @parameter expression="${width}" default-value="1200"</em>
<a name="95" href="#95">95</a>  <em class="jxr_javadoccomment">   */</em>
<a name="96" href="#96">96</a>    <strong class="jxr_keyword">int</strong> width = 1200;
<a name="97" href="#97">97</a>  
<a name="98" href="#98">98</a>    <em class="jxr_javadoccomment">/**</em>
<a name="99" href="#99">99</a>  <em class="jxr_javadoccomment">   * Rendered graph height in pixels.</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">   *</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">   * @parameter expression="${height}" default-value="1200"</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">   */</em>
<a name="103" href="#103">103</a>   <strong class="jxr_keyword">int</strong> height = 1200;
<a name="104" href="#104">104</a> 
<a name="105" href="#105">105</a>   <em class="jxr_javadoccomment">/**</em>
<a name="106" href="#106">106</a> <em class="jxr_javadoccomment">   * Should vertex name be full artifact ID.</em>
<a name="107" href="#107">107</a> <em class="jxr_javadoccomment">   *</em>
<a name="108" href="#108">108</a> <em class="jxr_javadoccomment">   * @parameter expression="${vertexFullLabel}" default-value="false"</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment">   */</em>
<a name="110" href="#110">110</a>   <strong class="jxr_keyword">boolean</strong> vertexFullLabel = false;
<a name="111" href="#111">111</a> 
<a name="112" href="#112">112</a>   <em class="jxr_javadoccomment">/**</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">   * Suppressed scopes.</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">   * &lt;p/&gt;</em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">   * Scopes that are not supposed to be shown on graph as edge labels.</em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">   * &lt;p/&gt;</em>
<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">   *</em>
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">   * @parameter expression="${suppressedScopes}" default-value="compile"</em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">   */</em>
<a name="120" href="#120">120</a>   String suppressedScopes;
<a name="121" href="#121">121</a> 
<a name="122" href="#122">122</a>   <em class="jxr_javadoccomment">/**</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment">   * Show version in graph.</em>
<a name="124" href="#124">124</a> <em class="jxr_javadoccomment">   *</em>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">   * As &lt;a href="<a href="http://code.google.com/p/maven-overview-plugin/issues/detail?id=16" target="alexandria_uri">http://code.google.com/p/maven-overview-plugin/issues/detail?id=16</a>"&gt;requested&lt;/a&gt;.</em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">   *</em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">   * @parameter expression="${showVersion}" default-value="false"</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment">   */</em>
<a name="129" href="#129">129</a>   <strong class="jxr_keyword">boolean</strong> showVersion = false;
<a name="130" href="#130">130</a> 
<a name="131" href="#131">131</a>   <em class="jxr_javadoccomment">/**</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">   * Directory where reports will go.</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">   *</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">   * @parameter expression="${project.reporting.outputDirectory}"</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">   * @required</em>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment">   * @readonly</em>
<a name="137" href="#137">137</a> <em class="jxr_javadoccomment">   */</em>
<a name="138" href="#138">138</a>   <strong class="jxr_keyword">private</strong> String outputDirectory;
<a name="139" href="#139">139</a> 
<a name="140" href="#140">140</a>   <em class="jxr_javadoccomment">/**</em>
<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">   * The projects in the reactor for aggregation report. &lt;p/&gt; Note: This is</em>
<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">   * passed by Maven and must not be configured by the user. &lt;/p&gt;</em>
<a name="143" href="#143">143</a> <em class="jxr_javadoccomment">   *</em>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment">   * @parameter expression="${reactorProjects}"</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">   * @readonly</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment">   */</em>
<a name="147" href="#147">147</a>   <strong class="jxr_keyword">private</strong> List reactorProjects;
<a name="148" href="#148">148</a> 
<a name="149" href="#149">149</a>   <em class="jxr_javadoccomment">/**</em>
<a name="150" href="#150">150</a> <em class="jxr_javadoccomment">   * Maven Project. Default value: ${project}</em>
<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">   *</em>
<a name="152" href="#152">152</a> <em class="jxr_javadoccomment">   * @parameter expression="${project}"</em>
<a name="153" href="#153">153</a> <em class="jxr_javadoccomment">   */</em>
<a name="154" href="#154">154</a>   <strong class="jxr_keyword">private</strong> MavenProject project;
<a name="155" href="#155">155</a> 
<a name="156" href="#156">156</a>   <em class="jxr_javadoccomment">/**</em>
<a name="157" href="#157">157</a> <em class="jxr_javadoccomment">   * Local Maven repository.</em>
<a name="158" href="#158">158</a> <em class="jxr_javadoccomment">   *</em>
<a name="159" href="#159">159</a> <em class="jxr_javadoccomment">   * @parameter expression="${localRepository}"</em>
<a name="160" href="#160">160</a> <em class="jxr_javadoccomment">   */</em>
<a name="161" href="#161">161</a>   <strong class="jxr_keyword">private</strong> ArtifactRepository localRepository;
<a name="162" href="#162">162</a> 
<a name="163" href="#163">163</a>   <em class="jxr_javadoccomment">/**</em>
<a name="164" href="#164">164</a> <em class="jxr_javadoccomment">   * Artifact collector, needed to resolve dependencies.</em>
<a name="165" href="#165">165</a> <em class="jxr_javadoccomment">   *</em>
<a name="166" href="#166">166</a> <em class="jxr_javadoccomment">   * @component role="org.apache.maven.artifact.resolver.ArtifactCollector"</em>
<a name="167" href="#167">167</a> <em class="jxr_javadoccomment">   * @required</em>
<a name="168" href="#168">168</a> <em class="jxr_javadoccomment">   * @readonly</em>
<a name="169" href="#169">169</a> <em class="jxr_javadoccomment">   */</em>
<a name="170" href="#170">170</a>   <strong class="jxr_keyword">private</strong> ArtifactCollector artifactCollector;
<a name="171" href="#171">171</a> 
<a name="172" href="#172">172</a>   <em class="jxr_javadoccomment">/**</em>
<a name="173" href="#173">173</a> <em class="jxr_javadoccomment">   * @component role="org.apache.maven.artifact.metadata.ArtifactMetadataSource"</em>
<a name="174" href="#174">174</a> <em class="jxr_javadoccomment">   * hint="maven"</em>
<a name="175" href="#175">175</a> <em class="jxr_javadoccomment">   */</em>
<a name="176" href="#176">176</a>   <strong class="jxr_keyword">protected</strong> ArtifactMetadataSource artifactMetadataSource;
<a name="177" href="#177">177</a> 
<a name="178" href="#178">178</a>   <em class="jxr_javadoccomment">/**</em>
<a name="179" href="#179">179</a> <em class="jxr_javadoccomment">   * @component</em>
<a name="180" href="#180">180</a> <em class="jxr_javadoccomment">   */</em>
<a name="181" href="#181">181</a>   <strong class="jxr_keyword">protected</strong> ArtifactFactory artifactFactory;
<a name="182" href="#182">182</a> 
<a name="183" href="#183">183</a>   <em class="jxr_javadoccomment">/**</em>
<a name="184" href="#184">184</a> <em class="jxr_javadoccomment">   * @component</em>
<a name="185" href="#185">185</a> <em class="jxr_javadoccomment">   */</em>
<a name="186" href="#186">186</a>   <strong class="jxr_keyword">private</strong> DependencyTreeBuilder dependencyTreeBuilder;
<a name="187" href="#187">187</a> 
<a name="188" href="#188">188</a>   <em class="jxr_javadoccomment">/**</em>
<a name="189" href="#189">189</a> <em class="jxr_javadoccomment">   * Generates the site report.</em>
<a name="190" href="#190">190</a> <em class="jxr_javadoccomment">   *</em>
<a name="191" href="#191">191</a> <em class="jxr_javadoccomment">   * @component</em>
<a name="192" href="#192">192</a> <em class="jxr_javadoccomment">   */</em>
<a name="193" href="#193">193</a>   <strong class="jxr_keyword">private</strong> Renderer siteRenderer;
<a name="194" href="#194">194</a> 
<a name="195" href="#195">195</a>   <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String BUNDLE_NAME = <span class="jxr_string">"overview"</span>;
<a name="196" href="#196">196</a>   <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DESCRIPTION = <span class="jxr_string">"report.overview.description"</span>;
<a name="197" href="#197">197</a>   <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String NAME = <span class="jxr_string">"report.overview.name"</span>;
<a name="198" href="#198">198</a>   <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> ResourceBundle info = ResourceBundle
<a name="199" href="#199">199</a>       .getBundle(BUNDLE_NAME, Locale.US);
<a name="200" href="#200">200</a>   <em class="jxr_javadoccomment">/**</em>
<a name="201" href="#201">201</a> <em class="jxr_javadoccomment">   * Plugin Information</em>
<a name="202" href="#202">202</a> <em class="jxr_javadoccomment">   */</em>
<a name="203" href="#203">203</a>   <strong class="jxr_keyword">private</strong> String pluginName = info.getString(<span class="jxr_string">"plugin.name"</span>);
<a name="204" href="#204">204</a>   <strong class="jxr_keyword">private</strong> String pluginVersion = info.getString(<span class="jxr_string">"plugin.version"</span>);
<a name="205" href="#205">205</a>   <strong class="jxr_keyword">private</strong> String pluginBuilder = info.getString(<span class="jxr_string">"plugin.buildBy"</span>);
<a name="206" href="#206">206</a>   <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> ITERATIONS = 1000;
<a name="207" href="#207">207</a> 
<a name="208" href="#208">208</a>   <strong class="jxr_keyword">public</strong> <a href="../../../../../com/googlecode/maven/plugins/overview/MavenOverviewMojo.html">MavenOverviewMojo</a>() {
<a name="209" href="#209">209</a>     suppressedScopes = <span class="jxr_string">"compile"</span>;
<a name="210" href="#210">210</a>   }
<a name="211" href="#211">211</a> 
<a name="212" href="#212">212</a>   <strong class="jxr_keyword">protected</strong> Renderer getSiteRenderer() {
<a name="213" href="#213">213</a>     <strong class="jxr_keyword">return</strong> siteRenderer;
<a name="214" href="#214">214</a>   }
<a name="215" href="#215">215</a> 
<a name="216" href="#216">216</a>   <strong class="jxr_keyword">protected</strong> String getOutputDirectory() {
<a name="217" href="#217">217</a>     <strong class="jxr_keyword">return</strong> outputDirectory;
<a name="218" href="#218">218</a>   }
<a name="219" href="#219">219</a> 
<a name="220" href="#220">220</a>   <strong class="jxr_keyword">protected</strong> MavenProject getProject() {
<a name="221" href="#221">221</a>     <strong class="jxr_keyword">return</strong> project;
<a name="222" href="#222">222</a>   }
<a name="223" href="#223">223</a> 
<a name="224" href="#224">224</a>   <strong class="jxr_keyword">public</strong> String getOutputName() {
<a name="225" href="#225">225</a>     <strong class="jxr_keyword">return</strong> <span class="jxr_string">"overview"</span>;
<a name="226" href="#226">226</a>   }
<a name="227" href="#227">227</a> 
<a name="228" href="#228">228</a>   <strong class="jxr_keyword">public</strong> String getName(Locale locale) {
<a name="229" href="#229">229</a>     <strong class="jxr_keyword">return</strong> getBundle(locale).getString(NAME);
<a name="230" href="#230">230</a>   }
<a name="231" href="#231">231</a> 
<a name="232" href="#232">232</a>   <strong class="jxr_keyword">public</strong> String getDescription(Locale locale) {
<a name="233" href="#233">233</a>     <strong class="jxr_keyword">return</strong> getBundle(locale).getString(DESCRIPTION);
<a name="234" href="#234">234</a>   }
<a name="235" href="#235">235</a> 
<a name="236" href="#236">236</a>   <strong class="jxr_keyword">private</strong> ResourceBundle getBundle(Locale locale) {
<a name="237" href="#237">237</a>     <strong class="jxr_keyword">return</strong> ResourceBundle
<a name="238" href="#238">238</a>         .getBundle(BUNDLE_NAME, locale, <strong class="jxr_keyword">this</strong>.getClass().getClassLoader());
<a name="239" href="#239">239</a>   }
<a name="240" href="#240">240</a> 
<a name="241" href="#241">241</a>   <em class="jxr_javadoccomment">/**</em>
<a name="242" href="#242">242</a> <em class="jxr_javadoccomment">   * Here goes execution of report.</em>
<a name="243" href="#243">243</a> <em class="jxr_javadoccomment">   *</em>
<a name="244" href="#244">244</a> <em class="jxr_javadoccomment">   * @param locale Current locale.</em>
<a name="245" href="#245">245</a> <em class="jxr_javadoccomment">   * @throws MavenReportException Say no more.</em>
<a name="246" href="#246">246</a> <em class="jxr_javadoccomment">   */</em>
<a name="247" href="#247">247</a>   <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> executeReport(Locale locale) <strong class="jxr_keyword">throws</strong> MavenReportException {
<a name="248" href="#248">248</a>     debugState();
<a name="249" href="#249">249</a>     Sink sink = getSink();
<a name="250" href="#250">250</a>     sink.head();
<a name="251" href="#251">251</a>     sink.title();
<a name="252" href="#252">252</a>     sink.text(getName(locale));
<a name="253" href="#253">253</a>     sink.title_();
<a name="254" href="#254">254</a>     sink.head_();
<a name="255" href="#255">255</a> 
<a name="256" href="#256">256</a>     sink.body();
<a name="257" href="#257">257</a>     sink.section1();
<a name="258" href="#258">258</a> 
<a name="259" href="#259">259</a>     sink.sectionTitle1();
<a name="260" href="#260">260</a>     sink.text(<span class="jxr_string">"Dependency Overview Graph for "</span> + getProject().getName());
<a name="261" href="#261">261</a>     sink.sectionTitle1_();
<a name="262" href="#262">262</a>     sink.lineBreak();
<a name="263" href="#263">263</a>     sink.lineBreak();
<a name="264" href="#264">264</a>     <em class="jxr_comment">// graph generation</em>
<a name="265" href="#265">265</a>     generateOverview();
<a name="266" href="#266">266</a>     sink.figure();
<a name="267" href="#267">267</a>     sink.figureGraphics(getGraphLocationInSite());
<a name="268" href="#268">268</a>     sink.figureCaption();
<a name="269" href="#269">269</a>     sink.text(<span class="jxr_string">"Dependency Overview Graph"</span>);
<a name="270" href="#270">270</a>     sink.figureCaption_();
<a name="271" href="#271">271</a>     sink.figure_();
<a name="272" href="#272">272</a>     sink.lineBreak();
<a name="273" href="#273">273</a>     sink.section1_();
<a name="274" href="#274">274</a>     sink.body_();
<a name="275" href="#275">275</a>     sink.flush();
<a name="276" href="#276">276</a>     sink.close();
<a name="277" href="#277">277</a>   }
<a name="278" href="#278">278</a> 
<a name="279" href="#279">279</a>   <em class="jxr_javadoccomment">/**</em>
<a name="280" href="#280">280</a> <em class="jxr_javadoccomment">   * Debug Mojo state.</em>
<a name="281" href="#281">281</a> <em class="jxr_javadoccomment">   */</em>
<a name="282" href="#282">282</a>   <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> debugState() {
<a name="283" href="#283">283</a>     getLog().debug(<span class="jxr_string">"MavenOverviewMojo: outputDirectory: "</span> + outputDirectory);
<a name="284" href="#284">284</a>     getLog().debug(
<a name="285" href="#285">285</a>         <span class="jxr_string">"MavenOverviewMojo: getReportOutputDirectory(): "</span>
<a name="286" href="#286">286</a>             + getReportOutputDirectory());
<a name="287" href="#287">287</a>   }
<a name="288" href="#288">288</a> 
<a name="289" href="#289">289</a>   <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> generateOverview() {
<a name="290" href="#290">290</a>     getLog().debug(
<a name="291" href="#291">291</a>         <span class="jxr_string">"MavenOverviewMojo: "</span> + pluginName + <span class="jxr_string">" v"</span> + pluginVersion + <span class="jxr_string">" build by "</span>
<a name="292" href="#292">292</a>             + pluginBuilder);
<a name="293" href="#293">293</a>     File outputFile = <strong class="jxr_keyword">new</strong> File(getGraphLocation());
<a name="294" href="#294">294</a>     <strong class="jxr_keyword">if</strong> (!outputFile.exists()) {
<a name="295" href="#295">295</a>       getLog().debug(
<a name="296" href="#296">296</a>           <span class="jxr_string">"MavenOverviewMojo: Creating outputFile: "</span> + outputFile
<a name="297" href="#297">297</a>               .getAbsolutePath());
<a name="298" href="#298">298</a>       outputFile.getParentFile().mkdirs();
<a name="299" href="#299">299</a>       getLog().info(<span class="jxr_string">"MavenOverviewMojo: Created outputFile: "</span> + outputFile);
<a name="300" href="#300">300</a>     }
<a name="301" href="#301">301</a> 
<a name="302" href="#302">302</a>     <em class="jxr_comment">// assure that projects groupId is included.</em>
<a name="303" href="#303">303</a>     <strong class="jxr_keyword">if</strong> (includes != <strong class="jxr_keyword">null</strong>
<a name="304" href="#304">304</a>         &amp;&amp; !<span class="jxr_string">""</span>.equals(includes.trim()) <em class="jxr_comment">// don't add if no includes defined.</em>
<a name="305" href="#305">305</a>         &amp;&amp; !includes.contains(project.getGroupId())) {
<a name="306" href="#306">306</a>       getLog().debug(
<a name="307" href="#307">307</a>           <span class="jxr_string">"MavenOverviewMojo: addind projects groupId ("</span>
<a name="308" href="#308">308</a>               + project.getGroupId() + <span class="jxr_string">") to includes ("</span> + includes + <span class="jxr_string">")."</span>);
<a name="309" href="#309">309</a>       includes += <span class="jxr_string">", "</span> + project.getGroupId();
<a name="310" href="#310">310</a>     }
<a name="311" href="#311">311</a>     getLog().debug(<span class="jxr_string">"MavenOverviewMojo: Collecting data"</span>);
<a name="312" href="#312">312</a>     
<a name="313" href="#313">313</a>     <a href="../../../../../com/googlecode/maven/plugins/overview/logic/DependencyProcessor.html">DependencyProcessor</a> dependencyProcessor = <strong class="jxr_keyword">new</strong> <a href="../../../../../com/googlecode/maven/plugins/overview/logic/DependencyProcessor.html">DependencyProcessor</a>(
<a name="314" href="#314">314</a>         includes,
<a name="315" href="#315">315</a>         exclusions,
<a name="316" href="#316">316</a>         maxDepth,
<a name="317" href="#317">317</a>         Arrays.asList(scopes),
<a name="318" href="#318">318</a>         dependencyTreeBuilder,
<a name="319" href="#319">319</a>         localRepository,
<a name="320" href="#320">320</a>         artifactFactory,
<a name="321" href="#321">321</a>         artifactMetadataSource,
<a name="322" href="#322">322</a>         artifactCollector,
<a name="323" href="#323">323</a>         <strong class="jxr_keyword">this</strong>);
<a name="324" href="#324">324</a> 
<a name="325" href="#325">325</a>     getLog().debug(<span class="jxr_string">"MavenOverviewMojo: Generating graph"</span>);
<a name="326" href="#326">326</a>     DirectedGraph graph = dependencyProcessor.createGraph(project, reactorProjects);
<a name="327" href="#327">327</a> 
<a name="328" href="#328">328</a>     getLog().debug(<span class="jxr_string">"MavenOverviewMojo: Rendering graph"</span>);
<a name="329" href="#329">329</a>     Layout layout = <strong class="jxr_keyword">new</strong> KKLayout(graph);
<a name="330" href="#330">330</a>     Dimension preferredSize = <strong class="jxr_keyword">new</strong> Dimension(width, height);
<a name="331" href="#331">331</a>     layout.initialize(preferredSize);
<a name="332" href="#332">332</a>     layout.resize(preferredSize);
<a name="333" href="#333">333</a>     <strong class="jxr_keyword">if</strong> (layout.isIncremental()) {
<a name="334" href="#334">334</a>       getLog().info(<span class="jxr_string">"MavenOverviewMojo: Incrementing graph"</span>);
<a name="335" href="#335">335</a>       <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; ITERATIONS; i++) {
<a name="336" href="#336">336</a>         layout.advancePositions();
<a name="337" href="#337">337</a>       }
<a name="338" href="#338">338</a>     }
<a name="339" href="#339">339</a> 
<a name="340" href="#340">340</a>     PluggableRenderer renderer = setupRenderer();
<a name="341" href="#341">341</a>     VisualizationViewer viewer = <strong class="jxr_keyword">new</strong> VisualizationViewer(
<a name="342" href="#342">342</a>         layout, renderer,
<a name="343" href="#343">343</a>         preferredSize);
<a name="344" href="#344">344</a>     viewer.setDoubleBuffered(false);
<a name="345" href="#345">345</a>     viewer.setSize(width, height);
<a name="346" href="#346">346</a>     viewer.setBackground(Color.WHITE);
<a name="347" href="#347">347</a>     Container container = <strong class="jxr_keyword">new</strong> Container();
<a name="348" href="#348">348</a>     container.addNotify();
<a name="349" href="#349">349</a>     container.add(viewer);
<a name="350" href="#350">350</a>     container.setVisible(<strong class="jxr_keyword">true</strong>);
<a name="351" href="#351">351</a>     BufferedImage image = <strong class="jxr_keyword">new</strong> BufferedImage(
<a name="352" href="#352">352</a>         width, height, BufferedImage.TYPE_INT_RGB);
<a name="353" href="#353">353</a>     Graphics2D graphics = image.createGraphics();
<a name="354" href="#354">354</a> 
<a name="355" href="#355">355</a>     container.paintComponents(graphics);
<a name="356" href="#356">356</a> 
<a name="357" href="#357">357</a>     writeOut(outputFile, image);
<a name="358" href="#358">358</a>   }
<a name="359" href="#359">359</a> 
<a name="360" href="#360">360</a>   <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeOut(<strong class="jxr_keyword">final</strong> File outputFile, <strong class="jxr_keyword">final</strong> BufferedImage image) {
<a name="361" href="#361">361</a>     getLog().debug(
<a name="362" href="#362">362</a>         <span class="jxr_string">"MavenOverviewMojo: Writing image to "</span> + outputFile.getAbsolutePath());
<a name="363" href="#363">363</a>     <strong class="jxr_keyword">try</strong> {
<a name="364" href="#364">364</a>       ImageIO.write(image, <span class="jxr_string">"png"</span>, outputFile);
<a name="365" href="#365">365</a>       getLog().info(<span class="jxr_string">"MavenOverviewMojo: Graph at: "</span> + outputFile);
<a name="366" href="#366">366</a>     } <strong class="jxr_keyword">catch</strong> (IOException ioe) {
<a name="367" href="#367">367</a>       getLog()
<a name="368" href="#368">368</a>           .error(<span class="jxr_string">"MavenOverviewMojo: Couldn't write to: "</span> + outputFile, ioe);
<a name="369" href="#369">369</a>     }
<a name="370" href="#370">370</a>   }
<a name="371" href="#371">371</a> 
<a name="372" href="#372">372</a>   <strong class="jxr_keyword">private</strong> PluggableRenderer setupRenderer() {
<a name="373" href="#373">373</a>     PluggableRenderer renderer = <strong class="jxr_keyword">new</strong> PluggableRenderer();
<a name="374" href="#374">374</a>     renderer.setVertexStringer(<strong class="jxr_keyword">new</strong> <a href="../../../../../com/googlecode/maven/plugins/overview/render/MyVertexStringer.html">MyVertexStringer</a>(vertexFullLabel, showVersion));
<a name="375" href="#375">375</a>     renderer.setVertexPaintFunction(<strong class="jxr_keyword">new</strong> <a href="../../../../../com/googlecode/maven/plugins/overview/render/MyVertexPaintFunction.html">MyVertexPaintFunction</a>());
<a name="376" href="#376">376</a>     renderer.setVertexShapeFunction(<strong class="jxr_keyword">new</strong> <a href="../../../../../com/googlecode/maven/plugins/overview/render/MyVertexShapeFunction.html">MyVertexShapeFunction</a>());
<a name="377" href="#377">377</a>     renderer.setVertexLabelCentering(<strong class="jxr_keyword">true</strong>);
<a name="378" href="#378">378</a>     renderer.setEdgeStringer(<strong class="jxr_keyword">new</strong> <a href="../../../../../com/googlecode/maven/plugins/overview/render/MyEdgeStringer.html">MyEdgeStringer</a>(suppressedScopes));
<a name="379" href="#379">379</a>     <strong class="jxr_keyword">return</strong> renderer;
<a name="380" href="#380">380</a>   }
<a name="381" href="#381">381</a> 
<a name="382" href="#382">382</a>   <strong class="jxr_keyword">private</strong> String getGraphLocation() {
<a name="383" href="#383">383</a>     getLog().debug(
<a name="384" href="#384">384</a>         <span class="jxr_string">"MavenOverviewMojo: getReportOutputDirectory(): "</span>
<a name="385" href="#385">385</a>             + getReportOutputDirectory().getAbsolutePath());
<a name="386" href="#386">386</a>     <strong class="jxr_keyword">return</strong> getReportOutputDirectory().getAbsolutePath() + File.separator
<a name="387" href="#387">387</a>         + getGraphLocationInSite();
<a name="388" href="#388">388</a>   }
<a name="389" href="#389">389</a> 
<a name="390" href="#390">390</a>   <strong class="jxr_keyword">public</strong> String getGraphLocationInSite() {
<a name="391" href="#391">391</a>     <strong class="jxr_keyword">return</strong> <span class="jxr_string">"images/"</span> + getOutputName() + <span class="jxr_string">".png"</span>;
<a name="392" href="#392">392</a>   }
<a name="393" href="#393">393</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

